fragment/androidx.fragment.app/[main]FragmentManager

FragmentManager

abstract class FragmentManager : FragmentResultOwner(source)

Static library support version of the framework's android.app.FragmentManager. Used to write apps that run on platforms prior to Android 3.0. When running on Android 3.0 or above, this implementation is still used; it does not try to switch to the framework's implementation. See the framework FragmentManager documentation for a class overview.

Your activity must derive from FragmentActivity to use this. From such an activity, you can acquire the FragmentManager by calling getSupportFragmentManager.

Constructors

FragmentManager

constructor()

Types

BackStackEntry

interface BackStackEntry

Representation of an entry on the fragment back stack, as created with FragmentTransaction.addToBackStack().

FragmentLifecycleCallbacks

abstract class FragmentLifecycleCallbacks

Callback interface for listening to fragment state changes that happen within a given FragmentManager.

OnBackStackChangedListener

interface OnBackStackChangedListener

Interface to watch for changes to the back stack.

Properties

POP_BACK_STACK_INCLUSIVE

val POP_BACK_STACK_INCLUSIVE: Int = 1

Flag for popBackStack and popBackStack: If set, and the name or ID of a back stack entry has been supplied, then all matching entries will be consumed until one that doesn't match is found or the bottom of the stack is reached.

TAG

@RestrictTo(value = RestrictTo.Scope.LIBRARY)

val TAG: String = "FragmentManager"

Functions

addFragmentOnAttachListener

open fun addFragmentOnAttachListener(@NonNull listener: FragmentOnAttachListener)

Add a FragmentOnAttachListener that should receive a call to onAttachFragment when a new Fragment is attached to this FragmentManager.

addOnBackStackChangedListener

open fun addOnBackStackChangedListener(@NonNull listener: FragmentManager.OnBackStackChangedListener)

Add a new listener for changes to the fragment back stack.

beginTransaction

@NonNull

open fun beginTransaction(): FragmentTransaction

Start a series of edit operations on the Fragments associated with this FragmentManager.

clearBackStack

open fun clearBackStack(@NonNull name: String)

Clears the back stack previously saved via saveBackStack.

clearFragmentResult

fun clearFragmentResult(@NonNull requestKey: String)

Clears the stored result for the given requestKey.

clearFragmentResultListener

fun clearFragmentResultListener(@NonNull requestKey: String)

Clears the stored FragmentResultListener for the given requestKey.

dump

open fun dump(@NonNull prefix: String, @Nullable fd: FileDescriptor, @NonNull writer: PrintWriter, @Nullable args: Array<String>)

Print the FragmentManager's state into the given stream.

enableDebugLogging

open fun ~~enableDebugLogging~~(enabled: Boolean)

Control whether the framework's internal fragment manager debugging logs are turned on.

enablePredictiveBack

open fun enablePredictiveBack(enabled: Boolean)

Control whether FragmentManager uses the new state predictive back feature that allows seeing the previous Fragment when using gesture back.

executePendingTransactions

@MainThread

open fun executePendingTransactions(): Boolean

After a FragmentTransaction is committed with FragmentTransaction.commit(), it is scheduled to be executed asynchronously on the process's main thread.

findFragment

@NonNull

open fun <F : Fragment?> findFragment(@NonNull view: View): F

Find a Fragment associated with the given View.

findFragmentById

@Nullable

open fun findFragmentById(@IdRes id: Int): Fragment

Finds a fragment that was identified by the given id either when inflated from XML or as the container ID when added in a transaction.

findFragmentByTag

@Nullable

open fun findFragmentByTag(@Nullable tag: String): Fragment

Finds a fragment that was identified by the given tag either when inflated from XML or as supplied when added in a transaction.

findFragmentManager

@NonNull

open fun findFragmentManager(@NonNull view: View): FragmentManager

Recurse up the view hierarchy, looking for a FragmentManager

getBackStackEntryAt

@NonNull

open fun getBackStackEntryAt(index: Int): FragmentManager.BackStackEntry

Return the BackStackEntry at index index in the back stack; entries start index 0 being the bottom of the stack.

getBackStackEntryCount

open fun getBackStackEntryCount(): Int

Return the number of entries currently in the back stack.

getFragment

@Nullable

open fun getFragment(@NonNull bundle: Bundle, @NonNull key: String): Fragment

Retrieve the current Fragment instance for a reference previously placed with putFragment.

getFragmentFactory

@NonNull

open fun getFragmentFactory(): FragmentFactory

Gets the current FragmentFactory used to instantiate new Fragment instances.

getFragments

@NonNull

open fun getFragments(): List<Fragment>

Get a list of all fragments that are currently added to the FragmentManager.

getHost

@RestrictTo(value = RestrictTo.Scope.LIBRARY)

@NonNull

open fun getHost(): FragmentHostCallback<out Any>

getPrimaryNavigationFragment

@Nullable

open fun getPrimaryNavigationFragment(): Fragment

Return the currently active primary navigation fragment for this FragmentManager.

getStrictModePolicy

@Nullable

open fun getStrictModePolicy(): FragmentStrictMode.Policy

Returns the current policy for this FragmentManager.

isDestroyed

open fun isDestroyed(): Boolean

Returns true if the final Activity.onDestroy() call has been made on the FragmentManager's Activity, so this instance is now dead.

isLoggingEnabled

@RestrictTo(value = RestrictTo.Scope.LIBRARY)

open fun isLoggingEnabled(level: Int): Boolean

isStateSaved

open fun isStateSaved(): Boolean

Returns true if the FragmentManager's state has already been saved by its host.

onContainerAvailable

fun onContainerAvailable(@NonNull container: FragmentContainerView)

Callback for when the FragmentContainerView becomes available in the view hierarchy and the fragment manager can add the fragment view to its hierarchy.

openTransaction

@RestrictTo(value = LIBRARY_GROUP_PREFIX)

@NonNull

open fun ~~openTransaction~~(): FragmentTransaction

popBackStack

open fun popBackStack()

Pop the top state off the back stack.

open fun popBackStack(id: Int, flags: Int)

Pop all back stack states up to the one with the given identifier.

open fun popBackStack(@Nullable name: String, flags: Int)

Pop the last fragment transition from the manager's fragment back stack.

popBackStackImmediate